Pool Plan Top-up
This API is used to add allowances to the prepaid balance of an account’s attached Pool Plan.
At least one subscriber must be allocated to the Pool Plan.
| HTTP URL |
|
|---|---|
| POST | /api/v2/customer/{id}/offer/{id}/topup |
NOTE: Offer {id} is the product catalog offering ID.
Eligibility
The Requester is eligible to top-up to its customers’ (sub-account) Pool Plans only. The Requester is not eligible to top-up to itself or to any other customer level beyond the first tier (for example, a customer’s customer).
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
charge |
Decimal |
M |
Top-up cost. Charge of postpaid balance. |
|
currency |
String |
M |
Monetary: for example, USD, GBP, EUR |
|
expirationDate |
Date |
O |
Determines the requested date as per the selected expirationType set when plan created. Can be used only if the expirationType parameter has been set to FIXED. Ignored for other expirationType settings. |
|
allowance |
Object |
M |
Object of allowance per service. |
Allowance Data Objects
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
currency |
String |
M |
Allowance:
|
|
value |
Decimal |
M |
Balance amount |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. |
|
errorMessage |
String |
O |
Failure message. |
|
content |
Object |
O |
Array of main response body object displayed when an API call was successful. For a failure, it will be empty. |
|
pageable |
Object |
O |
Paging information object displayed when an API call was successful. For a failure, it will be empty. |
Content data objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| requestId | UUID |
M |
Request instance ID. To be used by external systems to query the call (operation) status:
|
Pageable data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
page |
Numeric |
M |
Page number |
|
size |
Numeric |
M |
Page size. Number of requested elements per page |
|
totalPages |
Numeric |
M |
Total amount of available pages per requested page size |
|
totalElements |
Numeric |
M |
Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
|
Code |
Message |
|---|---|
|
CUSTOMER_1002 |
Customer does not exist |
|
CUSTOMER_1009 |
Top-up failure. Balance not found |
|
CUSTOMER_1010 |
Pool plan for your account was not found |
|
CUSTOMER_1011 |
There are no subscribers attached to this pool plan. Top-up denied. |
|
GLOBAL_1001 |
Service unavailable. Please try again |
Examples
Request Body
{
"charge": 20.5,
"currency": "EUR",
"expirationDate": "25042023",
"allowance": [
{
"currency": "SMS",
"value": 50
}
]
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId":"e7fcef24-5c03-41dd-9e33-995b7d6f32b1"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Failure NAK
{
"errorCode": "SUBSCRIBER_1009",
"errorMessage": "Top-up failure. Balance not found",
"content": "",
"pageable": ""
}